﻿// ———————————————————————–
// <copyright file="EventTypeDescriptor.cs" company="The MITRE Corporation">
//    Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//    Licensed under the Apache License, Version 2.0 (the "License");
//    you may not use this file except in compliance with the License.
//    You may obtain a copy of the License at
//    http://www.apache.org/licenses/LICENSE-2.0
//    Unless required by applicable law or agreed to in writing, software
//    distributed under the License is distributed on an "AS IS" BASIS,
//    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//    See the License for the specific language governing permissions and
//    limitations under the License.
// </copyright>
// ———————————————————————–
/////////////////////////////////////////////////////////////////////////////////////////////////
// EventTypeDescriptor.cs:
//
// EMEvent Category
//
// Project: IC.NET - CAD Library
// Author:  Jim Cronin - MITRE
/////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright (c) 2014 The MITRE Corporation. All rights reserved.
//
// NOTICE
// This software was produced for the U. S. Government
// under Contract No. FA8721-09-C-0001, and is
// subject to the Rights in Noncommercial Computer Software
// and Noncommercial Computer Software Documentation Clause
// (DFARS) 252.227-7014 (JUN 1995)

using System;
using System.Collections.Generic;
using System.Xml;

namespace EDXLSharp.NIEMCADLib
{
  /// <summary>
  /// Represents an event category
  /// </summary>
  public class EventTypeDescriptor : IComposable
  {
    /// <summary>
    /// The type code for this category
    /// </summary>
    public EventTypeCode TypeCode { get; set; }

    /// <summary>
    /// Any community extended type codes
    /// </summary>
    public ICollection<EventTypeDescriptorExtension> Extensions { get; set; }

    public EventTypeDescriptor()
    {
      Extensions = new List<EventTypeDescriptorExtension>();
    }

    /// <summary>
    /// Writes this EventTypeDescriptor to an inline XML Document
    /// </summary>
    /// <param name="xwriter">Valid XMLWriter</param>
    /// <exception cref="System.ArgumentNullException">Thrown if xwriter is null</exception>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if validation fails</exception>
    public void WriteXML(XmlWriter xwriter)
    {
      if (xwriter == null)
      {
        throw new ArgumentNullException("xwriter");
      }

      Validate();

      xwriter.WriteStartElement(EDXLConstants.EMEventPrefix, "EventTypeDescriptor", EDXLConstants.EMEventNamespace);
      TypeCode.WriteXML(xwriter);
      foreach (EventTypeDescriptorExtension ext in Extensions)
      {
        ext.WriteXML(xwriter);
      }
      xwriter.WriteEndElement();
    }

    /// <summary>
    /// Reads this EventTypeDescriptor's values from an XML NodeList
    /// </summary>
    /// <param name="rootnode">Root XML Node of the Object Element</param>
    /// <exception cref="System.ArgumentNullException">Thrown if rootnode is null</exception>
    /// <exception cref="System.ArgumentException">Thrown if rootnode is not an EventTypeCode</exception>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if validation fails</exception>
    public void ReadXML(XmlNode rootnode)
    {
      if (rootnode == null)
      {
        throw new ArgumentNullException("rootnode");
      }
      if (rootnode.LocalName != "EventTypeDescriptor")
      {
        throw new ArgumentException("Not an EventTypeDescriptor!");
      }

      foreach (XmlNode node in rootnode.ChildNodes)
      {
        switch (node.LocalName)
        {
          case "EventTypeCode":
            TypeCode = new EventTypeCode();
            TypeCode.ReadXML(node);
            break;
          case "EventTypeDescriptorExtension":
            EventTypeDescriptorExtension ext = new EventTypeDescriptorExtension();
            ext.ReadXML(node);
            Extensions.Add(ext);
            break;
          default:
            throw new ArgumentException("Unexpected element " + node.LocalName + " in EventTypeDescriptor");
        }
      }

      Validate();
    }

    /// <summary>
    /// Validates the type code
    /// </summary>
    /// <exception cref="EDXLSharp.ValidationException">Thrown if validation fails</exception>
    public void Validate()
    {
      if (TypeCode == null)
      {
        throw new ValidationException("EventTypeDescriptor missing required element EventTypeCode");
      }
      TypeCode.Validate();

      foreach (EventTypeDescriptorExtension ext in Extensions)
      {
        ext.Validate();
      }
    }
  }
}